<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    package org.hackystat.sensorbase.resource.sensorbase;<a name="line.1"></a>
<FONT color="green">002</FONT>    <a name="line.2"></a>
<FONT color="green">003</FONT>    import java.util.logging.Logger;<a name="line.3"></a>
<FONT color="green">004</FONT>    <a name="line.4"></a>
<FONT color="green">005</FONT>    import org.hackystat.sensorbase.resource.users.jaxb.User;<a name="line.5"></a>
<FONT color="green">006</FONT>    import org.hackystat.utilities.stacktrace.StackTrace;<a name="line.6"></a>
<FONT color="green">007</FONT>    <a name="line.7"></a>
<FONT color="green">008</FONT>    /**<a name="line.8"></a>
<FONT color="green">009</FONT>     * Provides standardized strings and formatting for response codes.  <a name="line.9"></a>
<FONT color="green">010</FONT>     * This class is intended to make error reporting more uniform and informative. <a name="line.10"></a>
<FONT color="green">011</FONT>     * A good error message will always include an explanation for why the operation failed,<a name="line.11"></a>
<FONT color="green">012</FONT>     * and what the requested operation was. <a name="line.12"></a>
<FONT color="green">013</FONT>     * @author Philip Johnson<a name="line.13"></a>
<FONT color="green">014</FONT>     */<a name="line.14"></a>
<FONT color="green">015</FONT>    public class ResponseMessage {<a name="line.15"></a>
<FONT color="green">016</FONT>      <a name="line.16"></a>
<FONT color="green">017</FONT>      /**<a name="line.17"></a>
<FONT color="green">018</FONT>       * The error message for requests that only the admin can handle. <a name="line.18"></a>
<FONT color="green">019</FONT>       * @param resource The resource associated with this request. <a name="line.19"></a>
<FONT color="green">020</FONT>       * @return A string describing the problem.<a name="line.20"></a>
<FONT color="green">021</FONT>       */<a name="line.21"></a>
<FONT color="green">022</FONT>       static String adminOnly(SensorBaseResource resource) {<a name="line.22"></a>
<FONT color="green">023</FONT>        return String.format("Request requires administrator privileges:%n  Request: %s %s",<a name="line.23"></a>
<FONT color="green">024</FONT>            resource.getRequest().getMethod().getName(),<a name="line.24"></a>
<FONT color="green">025</FONT>            resource.getRequest().getResourceRef().toString());<a name="line.25"></a>
<FONT color="green">026</FONT>      }<a name="line.26"></a>
<FONT color="green">027</FONT>      <a name="line.27"></a>
<FONT color="green">028</FONT>      /**<a name="line.28"></a>
<FONT color="green">029</FONT>       * The error message for requests where the authorized user must be the same as the user<a name="line.29"></a>
<FONT color="green">030</FONT>       * in the URI string, or the authorized use is the admin (and then the user in the URI string<a name="line.30"></a>
<FONT color="green">031</FONT>       * can be anyone).<a name="line.31"></a>
<FONT color="green">032</FONT>       * @param resource The resource associated with this request.<a name="line.32"></a>
<FONT color="green">033</FONT>       * @param authUser The authorized user. <a name="line.33"></a>
<FONT color="green">034</FONT>       * @param uriUser The user in the URI string.  <a name="line.34"></a>
<FONT color="green">035</FONT>       * @return A string describing the problem.<a name="line.35"></a>
<FONT color="green">036</FONT>       */<a name="line.36"></a>
<FONT color="green">037</FONT>      static String adminOrAuthUserOnly(SensorBaseResource resource, String authUser, <a name="line.37"></a>
<FONT color="green">038</FONT>          String uriUser) {<a name="line.38"></a>
<FONT color="green">039</FONT>        return String.format("Request requires authorized user (%s) to be the same user as the " +<a name="line.39"></a>
<FONT color="green">040</FONT>            "URL user (%s):%n  Request: %s %s", authUser, uriUser, <a name="line.40"></a>
<FONT color="green">041</FONT>            resource.getRequest().getMethod().getName(),<a name="line.41"></a>
<FONT color="green">042</FONT>            resource.getRequest().getResourceRef().toString());<a name="line.42"></a>
<FONT color="green">043</FONT>      }<a name="line.43"></a>
<FONT color="green">044</FONT>      <a name="line.44"></a>
<FONT color="green">045</FONT>      /**<a name="line.45"></a>
<FONT color="green">046</FONT>       * The error message for requests that generate an unspecified internal error. <a name="line.46"></a>
<FONT color="green">047</FONT>       * @param resource The resource associated with this request. <a name="line.47"></a>
<FONT color="green">048</FONT>       * @param logger The logger. <a name="line.48"></a>
<FONT color="green">049</FONT>       * @param e The exception. <a name="line.49"></a>
<FONT color="green">050</FONT>       * @return A string describing the problem.<a name="line.50"></a>
<FONT color="green">051</FONT>       */<a name="line.51"></a>
<FONT color="green">052</FONT>      static String internalError(SensorBaseResource resource, Logger logger, Exception e) {<a name="line.52"></a>
<FONT color="green">053</FONT>        String message =  String.format("Internal error %s:%n  Request: %s %s",<a name="line.53"></a>
<FONT color="green">054</FONT>            e.getMessage(),<a name="line.54"></a>
<FONT color="green">055</FONT>            resource.getRequest().getMethod().getName(),<a name="line.55"></a>
<FONT color="green">056</FONT>            resource.getRequest().getResourceRef().toString());<a name="line.56"></a>
<FONT color="green">057</FONT>        logger.info(String.format("%s\n%s", message, StackTrace.toString(e)));<a name="line.57"></a>
<FONT color="green">058</FONT>        return message;<a name="line.58"></a>
<FONT color="green">059</FONT>      }<a name="line.59"></a>
<FONT color="green">060</FONT>    <a name="line.60"></a>
<FONT color="green">061</FONT>      /**<a name="line.61"></a>
<FONT color="green">062</FONT>       * The error message for miscellaneous "one off" error messages. <a name="line.62"></a>
<FONT color="green">063</FONT>       * @param resource The resource associated with this request. <a name="line.63"></a>
<FONT color="green">064</FONT>       * @param message A short string describing the problem.<a name="line.64"></a>
<FONT color="green">065</FONT>       * @return A string describing the problem.<a name="line.65"></a>
<FONT color="green">066</FONT>       */<a name="line.66"></a>
<FONT color="green">067</FONT>       static String miscError(SensorBaseResource resource, String message) {<a name="line.67"></a>
<FONT color="green">068</FONT>        return String.format("Request generated error: %s:%n  Request: %s %s", <a name="line.68"></a>
<FONT color="green">069</FONT>            message,  <a name="line.69"></a>
<FONT color="green">070</FONT>            resource.getRequest().getMethod().getName(),<a name="line.70"></a>
<FONT color="green">071</FONT>            resource.getRequest().getResourceRef().toString());<a name="line.71"></a>
<FONT color="green">072</FONT>      }<a name="line.72"></a>
<FONT color="green">073</FONT>      <a name="line.73"></a>
<FONT color="green">074</FONT>      /**<a name="line.74"></a>
<FONT color="green">075</FONT>       * The error message for unknown users.<a name="line.75"></a>
<FONT color="green">076</FONT>       * @param resource The resource associated with this request. <a name="line.76"></a>
<FONT color="green">077</FONT>       * @param user A short string describing the problem.<a name="line.77"></a>
<FONT color="green">078</FONT>       * @return A string describing the problem.<a name="line.78"></a>
<FONT color="green">079</FONT>       */<a name="line.79"></a>
<FONT color="green">080</FONT>      static String undefinedUser(SensorBaseResource resource, String user) {<a name="line.80"></a>
<FONT color="green">081</FONT>        return String.format("Undefined user %s:%n  Request: %s %s", <a name="line.81"></a>
<FONT color="green">082</FONT>            user,<a name="line.82"></a>
<FONT color="green">083</FONT>            resource.getRequest().getMethod().getName(),<a name="line.83"></a>
<FONT color="green">084</FONT>            resource.getRequest().getResourceRef().toString());<a name="line.84"></a>
<FONT color="green">085</FONT>      }<a name="line.85"></a>
<FONT color="green">086</FONT>      <a name="line.86"></a>
<FONT color="green">087</FONT>      /**<a name="line.87"></a>
<FONT color="green">088</FONT>       * The error message for requests involving projects not owned by the specified user. <a name="line.88"></a>
<FONT color="green">089</FONT>       * @param resource The resource associated with this request. <a name="line.89"></a>
<FONT color="green">090</FONT>       * @param user The user. <a name="line.90"></a>
<FONT color="green">091</FONT>       * @param project The project. <a name="line.91"></a>
<FONT color="green">092</FONT>       * @return A string describing the problem.<a name="line.92"></a>
<FONT color="green">093</FONT>       */<a name="line.93"></a>
<FONT color="green">094</FONT>      static String undefinedProject(SensorBaseResource resource, User user, String project) {<a name="line.94"></a>
<FONT color="green">095</FONT>        return String.format("Undefined project %s for user %s:%n  Request: %s %s", <a name="line.95"></a>
<FONT color="green">096</FONT>             project, user.getEmail(),<a name="line.96"></a>
<FONT color="green">097</FONT>            resource.getRequest().getMethod().getName(),<a name="line.97"></a>
<FONT color="green">098</FONT>            resource.getRequest().getResourceRef().toString());<a name="line.98"></a>
<FONT color="green">099</FONT>      } <a name="line.99"></a>
<FONT color="green">100</FONT>      <a name="line.100"></a>
<FONT color="green">101</FONT>      /**<a name="line.101"></a>
<FONT color="green">102</FONT>       * The error message for requests involving projects not owned by the specified user. <a name="line.102"></a>
<FONT color="green">103</FONT>       * @param resource The resource associated with this request. <a name="line.103"></a>
<FONT color="green">104</FONT>       * @param user The user. <a name="line.104"></a>
<FONT color="green">105</FONT>       * @param project The project. <a name="line.105"></a>
<FONT color="green">106</FONT>       * @return A string describing the problem.<a name="line.106"></a>
<FONT color="green">107</FONT>       */<a name="line.107"></a>
<FONT color="green">108</FONT>      static String cannotViewProject(SensorBaseResource resource, String user, String project) {<a name="line.108"></a>
<FONT color="green">109</FONT>        return String.format("User %s not allowed to view project %s:%n  Request: %s %s", <a name="line.109"></a>
<FONT color="green">110</FONT>            user, project, <a name="line.110"></a>
<FONT color="green">111</FONT>            resource.getRequest().getMethod().getName(),<a name="line.111"></a>
<FONT color="green">112</FONT>            resource.getRequest().getResourceRef().toString());<a name="line.112"></a>
<FONT color="green">113</FONT>      }<a name="line.113"></a>
<FONT color="green">114</FONT>      <a name="line.114"></a>
<FONT color="green">115</FONT>      /**<a name="line.115"></a>
<FONT color="green">116</FONT>       * The error message for requests where the requesting user is not the owner. <a name="line.116"></a>
<FONT color="green">117</FONT>       * @param resource The resource associated with this request. <a name="line.117"></a>
<FONT color="green">118</FONT>       * @param user The user. <a name="line.118"></a>
<FONT color="green">119</FONT>       * @param project The project<a name="line.119"></a>
<FONT color="green">120</FONT>       * @return A string describing the problem.<a name="line.120"></a>
<FONT color="green">121</FONT>       */<a name="line.121"></a>
<FONT color="green">122</FONT>      static String notProjectOwner(SensorBaseResource resource, String user, String project) {<a name="line.122"></a>
<FONT color="green">123</FONT>        return String.format("Authorized user %s is not owner of project %s%n  Request: %s %s", <a name="line.123"></a>
<FONT color="green">124</FONT>            user, project,<a name="line.124"></a>
<FONT color="green">125</FONT>            resource.getRequest().getMethod().getName(),<a name="line.125"></a>
<FONT color="green">126</FONT>            resource.getRequest().getResourceRef().toString());<a name="line.126"></a>
<FONT color="green">127</FONT>      }<a name="line.127"></a>
<FONT color="green">128</FONT>      <a name="line.128"></a>
<FONT color="green">129</FONT>      <a name="line.129"></a>
<FONT color="green">130</FONT>      /**<a name="line.130"></a>
<FONT color="green">131</FONT>       * The error message for requests where a timestamp is not supplied or is not parsable.<a name="line.131"></a>
<FONT color="green">132</FONT>       * @param resource The resource associated with this request.<a name="line.132"></a>
<FONT color="green">133</FONT>       * @param timestamp The bogus timestamp. <a name="line.133"></a>
<FONT color="green">134</FONT>       * @return A string describing the problem.<a name="line.134"></a>
<FONT color="green">135</FONT>       */<a name="line.135"></a>
<FONT color="green">136</FONT>      static String badTimestamp(SensorBaseResource resource, String timestamp) {<a name="line.136"></a>
<FONT color="green">137</FONT>        return String.format("Bad timestamp %s:%n  Request: %s %s", <a name="line.137"></a>
<FONT color="green">138</FONT>            timestamp,<a name="line.138"></a>
<FONT color="green">139</FONT>            resource.getRequest().getMethod().getName(),<a name="line.139"></a>
<FONT color="green">140</FONT>            resource.getRequest().getResourceRef().toString());<a name="line.140"></a>
<FONT color="green">141</FONT>      }<a name="line.141"></a>
<FONT color="green">142</FONT>    <a name="line.142"></a>
<FONT color="green">143</FONT>    }<a name="line.143"></a>




























































</PRE>
</BODY>
</HTML>
